Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
This is a brief description which spans several lines of text. It continues until a blank line or until a new section command is encountered
This is a brief description which spans several lines of text. It continues until a blank line or until a new section command is encountered
The description then continues here...
This is how it looks in the source:
/**
\brief This is a brief description which spans several lines
of text and continues until a blank line or untill a new section command is encountered
The description then continues here...
*/
|
About section commands
This command is a section command (also called special section). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.
The section commands are:
\bug, \deprecated, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning
(Multiple commands are allowed yielding a bulleted list)
\author, \brief, \return, \version
(Only intended to be used once per entity)